The CRPEParameterFieldInfo structure contains information related to parameter fields in a report. This structure is used by CRPEJob::GetNthParameterField, to get information about a specific parameter field and by CRPEJob::SetNthParameterField, to change a specific parameter field.
Member | Type | Default | Description |
---|---|---|---|
Specifies the data type of the parameter field. The Crystal Report Engine supports the following data types and associated PEP_PF_XXX constants. | |||
Data Type | Constant | ||
Member | Type | Default | Description |
Specifies whether a default value is set for the parameter field. The value can be either TRUE if you want to change the default value or FALSE if you do not. | |||
Indicates whether a new value is being assigned to the parameter field. Use TRUE to indicate that a new value is set, FALSE to indicate no change. | |||
Specifies the name of the parameter field (of length PEP_PF_NAME_LEN = 256, NULL | |||
Specifies the prompting text (of length PEP_PF_PROMPT_LEN = 256, NULL | |||
Specifies the default value assigned to the parameter field. If the DefaultValueSet member is FALSE, this value is meaningless. DefaultValue can be a Number, Date, DateTime, Time, Boolean, or String (of length PEP_PF_VALUE_LEN = 256). | |||
Specifies the current value assigned to the parameter field. If CurrentValueSet is FALSE, this value is meaningless. CurrentValue can be a Number, Date, DateTime, Time, Boolean, or String (of length PEP_PF_VALUE_LEN = 256). | |||
The name of the report where the field belongs (used only with CRPEJob::GetNthParameterField, and NewParameterField; set only by the default constructor). | |||
Returns FALSE if the parameter is linked, not in use, or has current value set (set only by the default constructor). | |||
Specifies whether or not the parameter field is limited in length (Strings) or by a range (other data types). | |||
Depending on the value type, sets the minimum length of the string or minimum numeric value. | |||
Depending on the value type, sets the maximum length of the string or maximum numeric value. | |||
An edit mask (of length PEP_PF_EDITMASK_LEN = 256) that restricts what may be entered for string parameters. | |||
This constructs a CRPEParameterFieldInfo structure object. Call the constructor with no parameters to allow the Class Library to initialize all member variables with default values. Pass parameters to the constructor to assign specific values to each member variable.
CRPEParameterFieldInfo (
WORD ValueType,
WORD DefaultValueSet,
WORD CurrentValueSet,
const _TCHAR *Name,
const _TCHAR *Prompt,
const _TCHAR *DefaultValue,
const _TCHAR *CurrentValue,
WORD isLimited,
double MinSize,
double MaxSize,
const _TCHAR *EditMask,
WORD isHidden );
Seagate Software IMG Holdings, Inc. http://www.seagatesoftware.com Support services: http://support.seagatesoftware.com |